vFire has two Application Programming Interfaces (or APIs), which enable you to develop programs that automate many common vFire transactions. This section of the documentation deals with the Classic API. For more information on the RESTful Alemba API, introduced in 9.7, see here.
Attribute transactions can be used for creating, updating and deleting attribute values. Attributes can be attached to various items in vFire.
AttributeCreate Transaction
The AttributeCreate transaction can be used to add an attribute to a call, request or task.
Input Parameters: AttributeRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Ignored |
- |
Ignored on Create |
|
nHdRef |
Integer |
Yes |
- |
Call / Request / Task Number |
|
nEntityType |
Integer |
Yes |
- |
The type of entity to which the attribute will be added. Values: 1 = Call 2 = Request 3 = Task |
|
lTier1 |
Lookup Field |
Yes |
|
Tier 1 attribute |
|
lTier2 |
Lookup Field |
No |
|
Tier 2 attribute |
|
lTier3 |
Lookup Field |
No |
|
Tier 3 attribute |
|
sValue1 |
String |
No |
|
Attribute value |
|
aCustomParameters |
Array |
No |
“” |
Return Values: AttributeResponse
|
Argument |
Type |
Description |
|---|---|---|
|
nEntityRef |
Integer |
New attribute ref |
|
String |
Error/Warning Message |
|
|
Ret |
Error/Warning Number |
AttributeUpdate Transaction
The AttributeUpdate transaction can be used to modify an attribute.
Input Parameters: AttributeUpdateRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Yes |
- |
Attribute to update |
|
sValue1 |
String |
No |
“” |
Attribute Value |
|
aCustomParameters |
Array |
No |
“” |
Return Values: AttributeResponse
See AttributeResponse for more information.
AttributeRetrieve Transaction
The AttributeRetrieve transaction can be used to retrieve attribute values.
Input Parameters: AttributeRetrieveRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Yes |
- |
Attribute to retrieve |
|
aCustomParameters |
Array |
No |
“” |
Return Values: AttributeRetrieveResponse
|
Argument |
Type |
Description |
|---|---|---|
|
Ret |
Error/Warning Number |
|
|
String |
Error/Warning Message |
|
|
ResultSet |
DataSet |
AttributeDelete Transaction
The AttributeDelete transaction can be used to delete an attribute.
Input Parameters: AttributeDeleteRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Yes |
- |
Attribute to delete. |
|
aCustomParameters |
Array |
No |
“” |
Return Values: AttributeResponse
See AttributeResponse for more information.